Skip to content

feat(repo): apply GC OSS Repo Template#55

Merged
Souheil-Yazji merged 15 commits intomainfrom
bryan/update-repo-to-spec
Apr 14, 2026
Merged

feat(repo): apply GC OSS Repo Template#55
Souheil-Yazji merged 15 commits intomainfrom
bryan/update-repo-to-spec

Conversation

@bryanpaget
Copy link
Copy Markdown
Collaborator

@bryanpaget bryanpaget commented Jun 17, 2025

Context:

  • The namespace-cleaner has its own repo but none of the safeguards or settings of the repo have been configured to spec.

Todo:

Expected Outcome:

  • Repo has settings to protect main branch and other standard safety settings.
  • Repo follows GC OSS template.

This was linked to issues Jun 17, 2025
@bryanpaget bryanpaget requested a review from Souheil-Yazji June 18, 2025 13:06
@bryanpaget bryanpaget self-assigned this Jun 18, 2025
@bryanpaget bryanpaget added documentation Improvements or additions to documentation enhancement New feature or request labels Jun 18, 2025
@bryanpaget bryanpaget added this to the First Stable Release: 1.0 milestone Jun 18, 2025
@bryanpaget bryanpaget marked this pull request as ready for review June 18, 2025 13:07
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Copy link
Copy Markdown

@wg102 wg102 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it normal the System overview section in the readme is eng only?

@JustinZhang17
Copy link
Copy Markdown
Member

@bryanpaget I noticed this pr changes the distribution license of the project to MIT, I believe the current license in your project is a GNU GPL (https://github.com/StatCan/namespace-cleaner/blob/main/LICENSE.txt), are you changing it?

GNU GPL: https://choosealicense.com/licenses/gpl-3.0/

Comment thread LICENSE.md Outdated
Comment thread SECURITY.md Outdated
Comment thread SECURITY.md Outdated
Comment thread CODE_OF_CONDUCT.md Outdated
Comment thread CODE_OF_CONDUCT.md Outdated
anrayliu
anrayliu previously approved these changes Jun 30, 2025
@bryanpaget bryanpaget removed the request for review from Souheil-Yazji July 2, 2025 17:37
Souheil-Yazji
Souheil-Yazji previously approved these changes Jul 2, 2025
Copy link
Copy Markdown
Contributor

@Souheil-Yazji Souheil-Yazji left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

Comment thread README.md Outdated
@bryanpaget bryanpaget dismissed stale reviews from Souheil-Yazji and anrayliu via 31c0f1f July 2, 2025 17:50
@bryanpaget bryanpaget requested review from JustinZhang17 and wg102 July 2, 2025 17:52
@JustinZhang17 JustinZhang17 requested a review from Copilot July 2, 2025 19:48
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR applies the GC OSS repository template by adding standard governance files and enhancing documentation with bilingual support.

  • Add SECURITY.md with vulnerability reporting guidelines in English and French.
  • Expand README.md to include detailed project overview, key features, CI/CD integration, configuration, and monitoring – all presented bilingually.
  • Introduce CONTRIBUTING.md and CODE_OF_CONDUCT.md following the GC template, both with English and French sections.

Reviewed Changes

Copilot reviewed 4 out of 5 changed files in this pull request and generated 2 comments.

File Description
SECURITY.md Add security reporting instructions in English and French.
README.md Update project README with bilingual sections and template layout.
CONTRIBUTING.md Add contribution guidelines in English and French.
CODE_OF_CONDUCT.md Add code of conduct in English and French.
Comments suppressed due to low confidence (2)

README.md:93

  • [nitpick] To keep the README fully bilingual, add a French equivalent heading (e.g., ‘## Vue d’ensemble du système’) before or after this line.
## System Overview

README.md:209

  • [nitpick] Consider adding a French translation for this section heading and inline comments to match the bilingual style used elsewhere.
## Configuration

Comment thread SECURITY.md

## Sécurité

**Ne publiez aucun problème de sécurité sur le dépôt publique!** Les vulnérabilités de sécurité doivent être signalées par courriel à `statcan.cybersecurity-cybersecurite.statcan@statcan.gc.ca`
Copy link

Copilot AI Jul 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In French, ‘dépôt’ is masculine, so the adjective should be ‘public’ rather than ‘publique’.

Suggested change
**Ne publiez aucun problème de sécurité sur le dépôt publique!** Les vulnérabilités de sécurité doivent être signalées par courriel à `statcan.cybersecurity-cybersecurite.statcan@statcan.gc.ca`
**Ne publiez aucun problème de sécurité sur le dépôt public!** Les vulnérabilités de sécurité doivent être signalées par courriel à `statcan.cybersecurity-cybersecurite.statcan@statcan.gc.ca`

Copilot uses AI. Check for mistakes.
Comment thread CONTRIBUTING.md

### Sécurité

**Ne publiez aucun problème de sécurité sur le dépôt publique!** Voir [SECURITY.md](SECURITY.md) No newline at end of file
Copy link

Copilot AI Jul 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Apply the same correction here: use ‘dépôt public’ instead of ‘dépôt publique’.

Suggested change
**Ne publiez aucun problème de sécurité sur le dépôt publique!** Voir [SECURITY.md](SECURITY.md)
**Ne publiez aucun problème de sécurité sur le dépôt public!** Voir [SECURITY.md](SECURITY.md)

Copilot uses AI. Check for mistakes.
Comment thread README.md

#### License

Unless otherwise noted, the source code of this project is covered under Crown Copyright, Government of Canada, and is distributed under the [GNU Affero General Public License](LICENSE).
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like this, no suggestion, just a happy comment :)

Comment thread README.md Outdated
Comment on lines +153 to +158
## Key Features

* ✅ **Automated Lifecycle Management** – Label-based namespace retention system
* 🔒 **Security First** – Azure Entra ID user verification with domain allowlist
* 🧪 **Testing Friendly** – Mock and dry-run support
* ☁️ **Safe Operations** – Prevent accidental deletion through preview-only mode
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't this section be above with the rest of the english section? Sorry for all the comments lol

Comment thread README.md Outdated
Comment on lines +193 to +205
## CI/CD Integration / Intégration CI/CD

Our GitHub Actions pipeline includes:
Notre pipeline GitHub Actions comprend :

* ✅ Unit testing and dry-run validation
✅ Tests unitaires et validation en mode simulation
* 🔒 Trivy-based container image vulnerability scanning
🔒 Analyse de vulnérabilités des images avec Trivy
* 📦 Docker builds on push
📦 Construction des images Docker lors des *push*
* 📈 Live test coverage badge generation
📈 Génération d'un badge de couverture de test en temps réel
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't the english and french be separated?

@Souheil-Yazji Souheil-Yazji merged commit 2732a65 into main Apr 14, 2026
1 check failed
@Souheil-Yazji Souheil-Yazji deleted the bryan/update-repo-to-spec branch April 14, 2026 16:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Comply with GC OSS Repo Template Document License in Readme

6 participants